<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  <title>tango.sys.Pipe</title>
  <link href="./css/style.css" rel="stylesheet" type="text/css"/>
  <!-- <link href="./img/icon.png" rel="icon" type="image/png"/> -->
  <script type="text/javascript" src="./js/jquery.js"></script>
  <script type="text/javascript" src="./js/modules.js"></script>
  <script type="text/javascript" src="./js/quicksearch.js"></script>
  <script type="text/javascript" src="./js/navigation.js"></script>
  <!--<script type="text/javascript" src="./js/jquery.treeview.js"></script>-->
  <script type="text/javascript">
    var g_moduleFQN = "tango.sys.Pipe";
  </script>
  
</head>
<body>
<div id="content">
  <h1><a href="./htmlsrc/tango.sys.Pipe.html" class="symbol">tango.sys.Pipe</a></h1>
  
<p class="sec_header">License:</p>BSD style: see <a href="http://www.dsource.org/projects/tango/wiki/LibraryLicense">license.txt</a>
<p class="sec_header">Author:</p>Juan Jose Comellas <juanjo@comellas.com.ar>
<dl>
<dt class="decl">class <a class="symbol _class" name="PipeConduit" href="./htmlsrc/tango.sys.Pipe.html#L32" kind="class" beg="32" end="138">PipeConduit</a> : DeviceConduit; <a title="Permalink to this symbol" href="#PipeConduit" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L32">#</a></dt>
<dd class="ddef">
<div class="summary">Conduit for pipes.</div>
Each PipeConduit can only read or write, depending on the way it has been
 created.
<dl>
<dt class="decl"><a class="symbol _ctor" name="PipeConduit.this" href="./htmlsrc/tango.sys.Pipe.html#L58" kind="ctor" beg="58" end="66">this</a><span class="params">(ISelectable.Handle <em>handle</em>, uint <em>bufferSize</em> = DefaultBufferSize)</span>; <span class="attrs">[<span class="prot">private</span>]</span> <a title="Permalink to this symbol" href="#PipeConduit.this" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L58">#</a></dt>
<dd class="ddef">
<div class="summary">Create a PipeConduit with the provided handle and access permissions.</div>
<p class="sec_header">Params:</p>
<table class="params">
<tr><td><em>handle</em></td><td>handle of the operating system pipe we will wrap inside
                the PipeConduit.</td></tr>
<tr><td><em>style</em></td><td>access flags for the pipe (readable, writable, etc.).</td></tr>
<tr><td><em>bufferSize</em></td><td>buffer size.</td></tr></table></dd>
<dt class="decl"><a class="symbol _dtor" name="PipeConduit.~this" href="./htmlsrc/tango.sys.Pipe.html#L71" kind="dtor" beg="71" end="74">~this</a>(); <span class="attrs">[<span class="prot">public</span>]</span> <a title="Permalink to this symbol" href="#PipeConduit.~this" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L71">#</a></dt>
<dd class="ddef">
<div class="summary">Destructor.</div></dd>
<dt class="decl">uint <a class="symbol _function" name="PipeConduit.bufferSize" href="./htmlsrc/tango.sys.Pipe.html#L79" kind="function" beg="79" end="82">bufferSize</a><span class="params">()</span>; <span class="attrs">[<span class="prot">public</span>, <span class="stc">override</span>]</span> <a title="Permalink to this symbol" href="#PipeConduit.bufferSize" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L79">#</a></dt>
<dd class="ddef">
<div class="summary">Returns the buffer size for the PipeConduit.</div></dd>
<dt class="decl">char[] <a class="symbol _function" name="PipeConduit.toString" href="./htmlsrc/tango.sys.Pipe.html#L87" kind="function" beg="87" end="90">toString</a><span class="params">()</span>; <span class="attrs">[<span class="prot">public</span>, <span class="stc">override</span>]</span> <a title="Permalink to this symbol" href="#PipeConduit.toString" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L87">#</a></dt>
<dd class="ddef">
<div class="summary">Returns the name of the device.</div></dd></dl></dd>
<dt class="decl">class <a class="symbol _class" name="Pipe" href="./htmlsrc/tango.sys.Pipe.html#L143" kind="class" beg="143" end="223">Pipe</a>; <a title="Permalink to this symbol" href="#Pipe" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L143">#</a></dt>
<dd class="ddef">
<div class="summary">Factory class for Pipes.</div>
<dl>
<dt class="decl"><a class="symbol _ctor" name="Pipe.this" href="./htmlsrc/tango.sys.Pipe.html#L151" kind="ctor" beg="151" end="175">this</a><span class="params">(uint <em>bufferSize</em> = PipeConduit.DefaultBufferSize)</span>; <span class="attrs">[<span class="prot">public</span>]</span> <a title="Permalink to this symbol" href="#Pipe.this" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L151">#</a></dt>
<dd class="ddef">
<div class="summary">Create a Pipe.</div></dd>
<dt class="decl"><a class="symbol _ctor" name="Pipe.this:2" href="./htmlsrc/tango.sys.Pipe.html#L183" kind="ctor" beg="183" end="197">this</a><span class="params">(uint <em>bufferSize</em>, SECURITY_ATTRIBUTES * <em>sa</em>)</span>; <span class="attrs">[<span class="prot">package</span>]</span> <a title="Permalink to this symbol" href="#Pipe.this:2" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L183">#</a></dt>
<dd class="ddef">
<div class="summary">Helper constructor for pipes on Windows with non-null security
 attributes.</div></dd>
<dt class="decl">PipeConduit <a class="symbol _function" name="Pipe.sink" href="./htmlsrc/tango.sys.Pipe.html#L203" kind="function" beg="203" end="206">sink</a><span class="params">()</span>; <span class="attrs">[<span class="prot">public</span>]</span> <a title="Permalink to this symbol" href="#Pipe.sink" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L203">#</a></dt>
<dd class="ddef">
<div class="summary">Return the PipeConduit that you can write to.</div></dd>
<dt class="decl">PipeConduit <a class="symbol _function" name="Pipe.source" href="./htmlsrc/tango.sys.Pipe.html#L211" kind="function" beg="211" end="214">source</a><span class="params">()</span>; <span class="attrs">[<span class="prot">public</span>]</span> <a title="Permalink to this symbol" href="#Pipe.source" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L211">#</a></dt>
<dd class="ddef">
<div class="summary">Return the PipeConduit that you can read from.</div></dd>
<dt class="decl">void <a class="symbol _function" name="Pipe.error" href="./htmlsrc/tango.sys.Pipe.html#L219" kind="function" beg="219" end="222">error</a><span class="params">()</span>; <span class="attrs">[<span class="prot">private</span>, <span class="stc">final</span>]</span> <a title="Permalink to this symbol" href="#Pipe.error" class="symlink">¶</a><a title="Go to the HTML source file" class="srclink" href="./htmlsrc/tango.sys.Pipe.html#L219">#</a></dt>
<dd class="ddef">
<div class="summary"></div></dd></dl></dd></dl>
</div>
<div id="footer">
  <p>Copyright (c) 2006 Juan Jose Comellas. All rights reserved</p>
  <p>Page generated by <a href="http://code.google.com/p/dil">dil</a> on Fri Dec 26 04:03:46 2008. Rendered by <a href="http://code.google.com/p/dil/wiki/Kandil">kandil</a>.</p>
</div>
</body>
</html>